Add bidirectional conversion between SQL files and @Sql annotations #383
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…g invocation outside of the formatter functionality.
…files and Sql annotations.
xterao
changed the title
…is applied to SQL generated by the action.
…ready exists when the action is executed.
…y after """, regardless of code style settings.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR implements bidirectional conversion functionality between SQL files and @SQL annotations in Doma DAO methods, enabling developers to seamlessly switch between inline SQL annotations and external SQL files.
- SQL annotation to file conversion: Converts @SQL, @select, @update, @insert, @delete, @BatchUpdate, @BatchInsert, @BatchDelete, and @script annotations to external SQL files with automatic formatting
- SQL file to annotation conversion: Converts external SQL files back to @SQL annotations with proper escaping and formatting
- Infrastructure improvements: New dedicated SQL formatter and comprehensive test coverage for both conversion directions
Reviewed Changes
Copilot reviewed 85 out of 85 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| New test data files | Expected output files for testing both conversion directions across different DAO annotation types |
| ConvertSqlFileToAnnotationActionTest.kt | Test cases for SQL file to @SQL annotation conversion functionality |
| ConvertSqlAnnotationToFileActionTest.kt | Test cases for @SQL annotation to SQL file conversion functionality |
| DomaToolsBundle*.properties | Internationalized messages for the new conversion actions |
| Intention descriptions | HTML documentation for the new intention actions |
| plugin.xml | Plugin registration for the two new intention actions |
| DaoInjectionSqlVisitor.kt | Refactored to use the new dedicated InjectionSqlFormatter |
| SqlInjectionPostProcessor.kt | Updated to use the new InjectionSqlFormatter |
| InjectionSqlFormatter.kt | New dedicated SQL formatter for injection contexts |
| PsiDaoMethod.kt | Enhanced to handle SQL file deletion when overwriting existing files |
| SqlAnnotationConverter.kt | Core conversion logic handling both directions with SQL formatting |
| ConvertSqlFileToAnnotationAction.kt | Intention action for converting SQL files to @SQL annotations |
| ConvertSqlAnnotationToFileAction.kt | Intention action for converting @SQL annotations to SQL files |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
src/main/kotlin/org/domaframework/doma/intellij/action/dao/SqlAnnotationConverter.kt
Outdated
Show resolved
Hide resolved
src/main/kotlin/org/domaframework/doma/intellij/formatter/processor/InjectionSqlFormatter.kt
Show resolved
Hide resolved
src/main/kotlin/org/domaframework/doma/intellij/action/dao/SqlAnnotationConverter.kt
Show resolved
Hide resolved
…generating an annotation from a file.
xterao
force-pushed
the
feature/sql-generate-by-annotation
branch
from
6fd2bba to
41dbfa2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements bidirectional conversion functionality between SQL files and @SQL annotations in Doma DAO methods, allowing developers to seamlessly switch between these
two SQL definition approaches.
Changes
New Features
SQL Annotation to File Conversion (
ConvertSqlAnnotationToFileAction)SQL File to Annotation Conversion (
ConvertSqlFileToAnnotationAction)SQL Annotation Converter Utility (
SqlAnnotationConverter)Infrastructure Improvements
InjectionSqlFormatter)Testing
� Generated with Claude Code
Co-Authored-By: Claude [email protected]